home *** CD-ROM | disk | FTP | other *** search
/ Emulator Universe CD / emulatoruniversecd1998.iso / CPC / Utils / CpcFile System / TEMPLATE.DOC < prev    next >
Encoding:
Text File  |  1996-02-15  |  6.4 KB  |  286 lines
  1.  
  2. NAME
  3. ----
  4.         CPCFS - CPCEmu Filesystem Maintenance           Version: 0.85
  5.  
  6.  
  7. SYNOPSIS
  8. --------
  9.         CPCFS                   to invoke an interactive session
  10.         CPCFS <commands> ...    to perform batch commands
  11.  
  12.  
  13. DESCRIPTION
  14. -----------
  15. CPCFS is a program to copy files form a DOS filesystem to a
  16. disk-image appropriate for CPCEmu, an emulator for the
  17. CPC464/664/6128 homecomputer series by Amstrad.
  18.  
  19. Note:    This documentation is generated out of CPCfs' help file CPCFS.HLP.
  20.     Some "See also"-hints can therefore be misleading!
  21.  
  22.  
  23. INVOCATION
  24. ----------
  25. ~invocation~
  26. Options are simply a shortcut for commands. The first argument can
  27. be the name of an imagefile, all following arguments are commands.
  28. If you omit a command and only give <image> ``dir'' is assumed.
  29.  
  30. ~variables~
  31.  
  32.  
  33. COMMANDS
  34. --------
  35. All commands are case insensitive. Some commands write an informational
  36. message, if they are invoked without an argument (mode, open, page,
  37. prompt, verbosity,...). Some commands have more names than one. You can
  38. use the name that you like most.
  39.  
  40. ~commands~
  41.  
  42. ~options~
  43.  
  44.  
  45. GENERAL commands
  46. ================
  47.  
  48. ~open~
  49. Closes the one in memory, if any. It appends the string ".DSK" to the 
  50. DOS filename, if no extension is given.
  51.  
  52.  
  53. ~close~
  54.  
  55. ~user~
  56.  
  57.  
  58. TRANSFER commands
  59. =================
  60.  
  61. ~get~
  62.  
  63. ~mget~
  64.  
  65. ~put~
  66.  
  67. ~mput~
  68.  
  69. ~mode~
  70. Printable characters are newlines (10,13) and characters between space (32)
  71. and tilde (126). <mode> can be abbreviated to its first character B, T, or A. 
  72.  
  73.  
  74. ~sysgen~
  75. It only works, if the image was formatted with two system tracks (e.g.
  76. system or vortex format). See STAT, if you want to know the format or
  77. whether CP/M is already in the image. 
  78.  
  79. To obtain a CP/M-image you can use the accompanying BASIC program
  80. GETCPM.BAS. It runs on a CPC and copies the system tracks off a real CPC
  81. disk to the file SYSTEM.CPM. Then transfer the file to DOS.
  82.  
  83. If you want to "sysgen" your vortex image, you must prepare CP/M first
  84. (see your vortex documentation). WARNING: I do not own a vortex drive
  85. nor its documentation, so I cannot tell if it works. Feedback it
  86. highly appreciated!!!
  87.  
  88.  
  89. DOS ACCESS commands
  90. ===================
  91.  
  92. ~!~
  93. Executes the program <command> in a DOS-Shell. If only a "!" is
  94. typed, CPCfs invokes the interactive shell given in the %COMSPEC% 
  95. environment variable or C:\COMMAND.COM if the variable isn't set. You
  96. must type EXIT to return from the shell to CPCfs. Contrary to other 
  97. commands there is no space needed behind the "!".
  98.  
  99.  
  100. ~cd~
  101.  
  102. The "L" in LCD (as well as in LDIR) reminds you, that this command 
  103. affects the local filesystem of DOS.
  104.  
  105.  
  106. ~ldir~
  107.  
  108.  
  109. CP/M MAINTENANCE commands
  110. =========================
  111.  
  112. Informational
  113. -------------
  114.  
  115. ~dir~
  116.  
  117. ~stat~
  118.  
  119. ~dpb~
  120. ~background~
  121.  
  122. ~comment~
  123.  
  124. ~type~
  125.  
  126. ~dump~
  127.  
  128. Note: Options for DUMP can be packed, but this can be confusing
  129.       E.g. DUMP -B0 -2B5 for blocks 0 to 5
  130.       or   DUMP -12     for blocks form beginning (1) to the same blook (2)
  131.  
  132.  
  133. Changing files
  134. --------------
  135.  
  136. ~format~
  137.  
  138. ~del~
  139.  
  140. ~ren~
  141. REN uses the well-known DOS order for renaming (think of the word TO
  142. between the filenames) and not the (possibly expected) CP/M order (think
  143. of ":=" between the filenames)
  144.  
  145.  
  146. ~attrib~
  147.  
  148. ~copy~
  149.  
  150.  
  151.  
  152. USER INTERFACE comamnds
  153. =======================
  154.  
  155. # <any-text>
  156.     This is a comment. Everything upto the next command is ignored.
  157.  
  158.  
  159. ~quit~
  160. Quits CPCFS. You can hit Ctrl-Z to achieve the same purpose, only faster!
  161.  
  162.  
  163. ~help~
  164. The startup helppage is:
  165. -----------------------------------------------------------------------------
  166. ~nothing~
  167. -----------------------------------------------------------------------------
  168.  
  169. ~source~
  170.  
  171. ~echo~
  172.  
  173. ~prompt~
  174.  
  175. ~cls~
  176.  
  177. ~force~
  178.  
  179. ~verbosity~
  180.  
  181. ~page~
  182. CPCfs has an internal pager for commands like DUMP, TYPE, and so on.
  183. With the PAGE command you can set the number of lines of your screen
  184. (the default is 25). If you set PAGE 0, you bypass the internal pager
  185. and things are displayed without stops.
  186.  
  187.  
  188.  
  189. FILENAMES
  190. ---------
  191. ~filenames~
  192.  
  193. EDITING
  194. -------
  195. ~editing~
  196.  
  197. VALUES & PERCENT EXPANSION
  198. --------------------------
  199. ~values~
  200. ~percent~
  201.  
  202.  
  203. FILES
  204. -----
  205. CPCFS.CFG
  206.     The commands in this file are executed every time CPCFS starts in
  207.     interactive mode. You can set the PROMPT here or open an often 
  208.     used image or ...
  209.  
  210.     CPCFS looks for it at first in the current directory and then in the
  211.     directory where CPCFS.EXE resides.
  212.  
  213. *.DSK
  214.     This is the default extension for imagfiles
  215.  
  216. *.CPM
  217.     This is the default extension for CP/M tracks saved by GETCPM.BAS
  218.     and needed by SYSGEN.
  219.  
  220. SEE ALSO 
  221. -------- 
  222. GETCPM.BAS, a Locomotive BASIC program to copy CP/M tracks off a
  223. diskette and save them to a file. Simply type it in your *original* CPC
  224. (you can leave out REMarks and PRINTs) and run it on a CP/M system disk.
  225. It creates a file, that you have to transfer in some way to DOS (read
  226. the CPCEmu documentation for various ways, how to arrange it). Finally
  227. use CPCfs' SYSGEN command to create a diskimage with CP/M.
  228.  
  229. DROPTAG.BAT, a batch file replacing DROPTAG.EXE of the former distribution.
  230.  
  231. RELATED WORKS
  232. -------------
  233. CPCEmu
  234.     (C) Marco Vieth (ali@uni-paderborn.de)
  235.     Current version:    1.3b
  236.     Available on:       ftp://oak.oakland.edu/Simtel/msdos/emulator
  237.                 or any other Simtel site
  238.  
  239. CPE
  240.     (C) Bernd Schmidt (crux@pool.informatik.rwth-aachen.de)
  241.     Current Version:    5.0
  242.     Available on:       ftp://oak.oakland.edu/Simtel/msdos/emulator
  243.                 or any other Simtel site
  244.  
  245. comp.sys.amstrad.8bit
  246.     A usenet newsgroup for discussing CPC related topics
  247.  
  248. http://arachnid.cm.cf.ac.uk/User/K.E.W.Thacker/Amstrad
  249.     A WWW page with a lot of CPC stuff.
  250.  
  251. ftp://ftp.ibp.fr/pub/amstrad/amstrad.faq
  252. ftp://rtfm.mit.edu/pub/usenet/comp.sys.amstrad.8bit
  253.     The Amstrad FAQ
  254.  
  255.  
  256. BUGS
  257. ----
  258. ~bugs~
  259.  
  260. LEGAL STUFF
  261. -----------
  262. Copyright:
  263. ~about~
  264. If you want to see any modification or supplements to CPCFS, contact me
  265. and I possibly include them in the distribution.
  266.  
  267. Trademarks:
  268.     "CPC", "Amsdos" is from Amstrad
  269.     "CP/M" is from Digital Research (now Novell) 
  270.     "Borland C" is from Borland
  271.     "ACTlib 1.7" is public domain and written by Marc Stern 
  272.  
  273.  
  274. AUTHOR
  275. ------
  276.     Derik van Zütphen
  277.  
  278.     email:  derik@pool.informatik.rwth-aachen.de
  279.     www:    http://www-users.informatik.rwth-aachen.de/~derik
  280.  
  281.     The latest version of CPCFS and recent patches can be found on
  282.     my WWW page:
  283.  
  284.         http://www-users.informatik.rwth-aachen.de/~derik/cpcfs
  285.  
  286.